<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VectSharp: VectSharp.FormattedText Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="Doxy.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="icon.svg"/></td>
  <td id="projectalign">
   <div id="projectname">VectSharp<span id="projectnumber">&#160;2.6.1</span>
   </div>
   <div id="projectbrief">A light library for C# vector graphics</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_vect_sharp_1_1_formatted_text.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_vect_sharp_1_1_formatted_text-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">VectSharp.FormattedText Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Represents a run of text that should be drawn with the same style.   
 <a href="class_vect_sharp_1_1_formatted_text.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5a239c744d40688c8108b11c9c5aebdd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#a5a239c744d40688c8108b11c9c5aebdd">FormattedText</a> (string text, <a class="el" href="class_vect_sharp_1_1_font.html">Font</a> font, <a class="el" href="namespace_vect_sharp.html#ad89d060535c63df4196d494335867778">Script</a> script=Script.Normal, <a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a> brush=null, <a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>? spacing=null)</td></tr>
<tr class="memdesc:a5a239c744d40688c8108b11c9c5aebdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> instance with the specified <em>text</em> , <em>font</em> , <em>script</em>  position and <em>brush</em> .   <a href="class_vect_sharp_1_1_formatted_text.html#a5a239c744d40688c8108b11c9c5aebdd">More...</a><br /></td></tr>
<tr class="separator:a5a239c744d40688c8108b11c9c5aebdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abaa2530b0ca4876b0b8505ccc897c4cb"><td class="memItemLeft" align="right" valign="top">static IEnumerable&lt; <a class="el" href="class_vect_sharp_1_1_formatted_text.html">FormattedText</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#abaa2530b0ca4876b0b8505ccc897c4cb">Format</a> (string text, <a class="el" href="class_vect_sharp_1_1_font.html">Font</a> normalFont, <a class="el" href="class_vect_sharp_1_1_font.html">Font</a> boldFont, <a class="el" href="class_vect_sharp_1_1_font.html">Font</a> italicFont, <a class="el" href="class_vect_sharp_1_1_font.html">Font</a> boldItalicFont, <a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a> defaultBrush=null, <a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>? spacing=null)</td></tr>
<tr class="memdesc:abaa2530b0ca4876b0b8505ccc897c4cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the formatting information contained in a text string into a collection of <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> objects.   <a href="class_vect_sharp_1_1_formatted_text.html#abaa2530b0ca4876b0b8505ccc897c4cb">More...</a><br /></td></tr>
<tr class="separator:abaa2530b0ca4876b0b8505ccc897c4cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c7fb60ffca625b8669f054af43262a8"><td class="memItemLeft" align="right" valign="top">static IEnumerable&lt; <a class="el" href="class_vect_sharp_1_1_formatted_text.html">FormattedText</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#a3c7fb60ffca625b8669f054af43262a8">Format</a> (string text, <a class="el" href="class_vect_sharp_1_1_font_family.html#a6cdec4eb0a660064bc416e81f69d3780">FontFamily.StandardFontFamilies</a> fontFamily, double fontSize, bool defaultUnderline=false, <a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a> defaultBrush=null, <a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>? spacing=null)</td></tr>
<tr class="memdesc:a3c7fb60ffca625b8669f054af43262a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse the formatting information contained in a text string into a collection of <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> objects, using fonts from a standard font family.   <a href="class_vect_sharp_1_1_formatted_text.html#a3c7fb60ffca625b8669f054af43262a8">More...</a><br /></td></tr>
<tr class="separator:a3c7fb60ffca625b8669f054af43262a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:afd922b76c7912503e48ae104216287cf"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#afd922b76c7912503e48ae104216287cf">Text</a><code> [get]</code></td></tr>
<tr class="memdesc:afd922b76c7912503e48ae104216287cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the text represented by this instance.   <a href="class_vect_sharp_1_1_formatted_text.html#afd922b76c7912503e48ae104216287cf">More...</a><br /></td></tr>
<tr class="separator:afd922b76c7912503e48ae104216287cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae43fc6b7442e9dd369803f33e6ddbaac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#ae43fc6b7442e9dd369803f33e6ddbaac">Font</a><code> [get]</code></td></tr>
<tr class="memdesc:ae43fc6b7442e9dd369803f33e6ddbaac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the font that should be used to draw the text.   <a href="class_vect_sharp_1_1_formatted_text.html#ae43fc6b7442e9dd369803f33e6ddbaac">More...</a><br /></td></tr>
<tr class="separator:ae43fc6b7442e9dd369803f33e6ddbaac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a880e388b62bd8493da1ccd58668784b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_vect_sharp.html#ad89d060535c63df4196d494335867778">Script</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#a880e388b62bd8493da1ccd58668784b9">Script</a><code> [get]</code></td></tr>
<tr class="memdesc:a880e388b62bd8493da1ccd58668784b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the position of the text.   <a href="class_vect_sharp_1_1_formatted_text.html#a880e388b62bd8493da1ccd58668784b9">More...</a><br /></td></tr>
<tr class="separator:a880e388b62bd8493da1ccd58668784b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04a80d0c9d59aeea79c8dadc104e82c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#a04a80d0c9d59aeea79c8dadc104e82c0">Brush</a><code> [get]</code></td></tr>
<tr class="memdesc:a04a80d0c9d59aeea79c8dadc104e82c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the brush that should be used to draw the text. If this is null, the default brush is used.   <a href="class_vect_sharp_1_1_formatted_text.html#a04a80d0c9d59aeea79c8dadc104e82c0">More...</a><br /></td></tr>
<tr class="separator:a04a80d0c9d59aeea79c8dadc104e82c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95f38776549b8a485840fd17c1b341b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_formatted_text.html#a95f38776549b8a485840fd17c1b341b4">Spacing</a><code> [get]</code></td></tr>
<tr class="memdesc:a95f38776549b8a485840fd17c1b341b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the text spacing parameters used to draw the text.   <a href="class_vect_sharp_1_1_formatted_text.html#a95f38776549b8a485840fd17c1b341b4">More...</a><br /></td></tr>
<tr class="separator:a95f38776549b8a485840fd17c1b341b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Represents a run of text that should be drawn with the same style.  </p>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00051">51</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5a239c744d40688c8108b11c9c5aebdd" name="a5a239c744d40688c8108b11c9c5aebdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a239c744d40688c8108b11c9c5aebdd">&#9670;&#160;</a></span>FormattedText()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">VectSharp.FormattedText.FormattedText </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a>&#160;</td>
          <td class="paramname"><em>font</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespace_vect_sharp.html#ad89d060535c63df4196d494335867778">Script</a>&#160;</td>
          <td class="paramname"><em>script</em> = <code>Script.Normal</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a>&#160;</td>
          <td class="paramname"><em>brush</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>?&#160;</td>
          <td class="paramname"><em>spacing</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> instance with the specified <em>text</em> , <em>font</em> , <em>script</em>  position and <em>brush</em> .  </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>The text that will be contained in the new <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a>.</td></tr>
    <tr><td class="paramname">font</td><td>The font that will be used by the new <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a>.</td></tr>
    <tr><td class="paramname">script</td><td>The script position of the new <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a>.</td></tr>
    <tr><td class="paramname">brush</td><td>The brush that will be used by the new <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a>.</td></tr>
    <tr><td class="paramname">spacing</td><td>The text spacing parameters used to draw the text.</td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00086">86</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abaa2530b0ca4876b0b8505ccc897c4cb" name="abaa2530b0ca4876b0b8505ccc897c4cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaa2530b0ca4876b0b8505ccc897c4cb">&#9670;&#160;</a></span>Format() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static IEnumerable&lt; <a class="el" href="class_vect_sharp_1_1_formatted_text.html">FormattedText</a> &gt; VectSharp.FormattedText.Format </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a>&#160;</td>
          <td class="paramname"><em>normalFont</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a>&#160;</td>
          <td class="paramname"><em>boldFont</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a>&#160;</td>
          <td class="paramname"><em>italicFont</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a>&#160;</td>
          <td class="paramname"><em>boldItalicFont</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a>&#160;</td>
          <td class="paramname"><em>defaultBrush</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>?&#160;</td>
          <td class="paramname"><em>spacing</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse the formatting information contained in a text string into a collection of <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> objects.  </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>The string containing formatting information. Format information is specified using HTML-like tags: <ul>
<li>
<code>&lt;b&gt;&lt;/b&gt;</code> or <code>&lt;strong&gt;&lt;/strong&gt;</code> are used for bold text; </li>
<li>
<code>&lt;i&gt;&lt;/i&gt;</code> or <code>&lt;em&gt;&lt;/em&gt;</code> are used for text in italics; </li>
<li>
<code>&lt;u&gt;&lt;/u&gt;</code> are used for underlined text; </li>
<li>
<code>&lt;sup&gt;&lt;/sup&gt;</code> and <code>&lt;sub&gt;&lt;/sub&gt;</code> are used, respectively, for superscript and subscript text; </li>
<li>
<code>&lt;#COLOUR&gt;&lt;/#&gt;</code> is used to specify the colour of the text, where <code>COLOUR</code> is a CSS colour string (e.g. <code>&lt;#red&gt;</code>, <code>&lt;#0080FF&gt;</code>, or <code>&lt;#rgba(128, 80, 52, 0.5)&gt;</code>). </li>
</ul>
</td></tr>
    <tr><td class="paramname">normalFont</td><td>The font that will be used for text that is neither bold nor italic.</td></tr>
    <tr><td class="paramname">boldFont</td><td>The font that will be used for text that is bold. Note that this does not necessarily have to be a bold font; this is just the font that is applied to text contained within <code>&lt;b&gt;&lt;/b&gt;</code> tags.</td></tr>
    <tr><td class="paramname">italicFont</td><td>The font that will be used for text that is in italics. Note that this does not necessarily have to be an italic font; this is just the font that is applied to text contained within <code>&lt;i&gt;&lt;/i&gt;</code> tags.</td></tr>
    <tr><td class="paramname">boldItalicFont</td><td>The font that will be used for text that is both in bold and in italics.</td></tr>
    <tr><td class="paramname">defaultBrush</td><td>The default <a class="el" href="class_vect_sharp_1_1_brush.html" title="Represents a brush used to fill or stroke graphics elements. This could be a solid colour,...">Brush</a> that will be used for text runs that do not specify a colour. If this is <code>null</code>, the default <a class="el" href="class_vect_sharp_1_1_brush.html" title="Represents a brush used to fill or stroke graphics elements. This could be a solid colour,...">Brush</a> will be the one specified in the painting call.</td></tr>
    <tr><td class="paramname">spacing</td><td>The text spacing parameters used to draw the text.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A lazy collection of <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> objects. Note that every enumeration of this collection causes the text to be parsed again; if you need to enumerate this collection more than once, you should probably convert it e.g. to a List&lt;T&gt;.</dd></dl>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00114">114</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<a id="a3c7fb60ffca625b8669f054af43262a8" name="a3c7fb60ffca625b8669f054af43262a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c7fb60ffca625b8669f054af43262a8">&#9670;&#160;</a></span>Format() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static IEnumerable&lt; <a class="el" href="class_vect_sharp_1_1_formatted_text.html">FormattedText</a> &gt; VectSharp.FormattedText.Format </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_font_family.html#a6cdec4eb0a660064bc416e81f69d3780">FontFamily.StandardFontFamilies</a>&#160;</td>
          <td class="paramname"><em>fontFamily</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>fontSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>defaultUnderline</em> = <code>false</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a>&#160;</td>
          <td class="paramname"><em>defaultBrush</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a>?&#160;</td>
          <td class="paramname"><em>spacing</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Parse the formatting information contained in a text string into a collection of <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> objects, using fonts from a standard font family.  </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>The string containing formatting information. Format information is specified using HTML-like tags: <ul>
<li>
<code>&lt;b&gt;&lt;/b&gt;</code> or <code>&lt;strong&gt;&lt;/strong&gt;</code> are used for bold text; </li>
<li>
<code>&lt;i&gt;&lt;/i&gt;</code> or <code>&lt;em&gt;&lt;/em&gt;</code> are used for text in italics; </li>
<li>
<code>&lt;u&gt;&lt;/u&gt;</code> are used for underlined text; </li>
<li>
<code>&lt;sup&gt;&lt;/sup&gt;</code> and <code>&lt;sub&gt;&lt;/sub&gt;</code> are used, respectively, for superscript and subscript text; </li>
<li>
<code>&lt;#COLOUR&gt;&lt;/#&gt;</code> is used to specify the colour of the text, where <code>COLOUR</code> is a CSS colour string (e.g. <code>&lt;#red&gt;</code>, <code>&lt;#0080FF&gt;</code>, or <code>&lt;#rgba(128, 80, 52, 0.5)&gt;</code>). </li>
</ul>
</td></tr>
    <tr><td class="paramname">fontFamily</td><td>The font family from which the fonts will be created. If this is a regular font family, the bold, italic and bold-italic versions of the font will be used for the formatted text. Otherwise, the relevant font styles will be toggled (e.g. if the supplied font family is bold, then regular text in the formatted string will be displayed as bold, while bold text in the formatted string will be displayed as regular text).</td></tr>
    <tr><td class="paramname">fontSize</td><td>The size of the fonts to use.</td></tr>
    <tr><td class="paramname">defaultUnderline</td><td>Determines whether text should be underlined by default. This is toggled by <code>&lt;u&gt;&lt;/u&gt;</code> tags.</td></tr>
    <tr><td class="paramname">defaultBrush</td><td>The default <a class="el" href="class_vect_sharp_1_1_brush.html" title="Represents a brush used to fill or stroke graphics elements. This could be a solid colour,...">Brush</a> that will be used for text runs that do not specify a colour. If this is <code>null</code>, the default <a class="el" href="class_vect_sharp_1_1_brush.html" title="Represents a brush used to fill or stroke graphics elements. This could be a solid colour,...">Brush</a> will be the one specified in the painting call.</td></tr>
    <tr><td class="paramname">spacing</td><td>The text spacing parameters used to draw the text.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A lazy collection of <a class="el" href="class_vect_sharp_1_1_formatted_text.html" title="Represents a run of text that should be drawn with the same style.">FormattedText</a> objects. Note that every enumeration of this collection causes the text to be parsed again; if you need to enumerate this collection more than once, you should probably convert it e.g. to a List&lt;T&gt;.</dd></dl>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00297">297</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a04a80d0c9d59aeea79c8dadc104e82c0" name="a04a80d0c9d59aeea79c8dadc104e82c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04a80d0c9d59aeea79c8dadc104e82c0">&#9670;&#160;</a></span>Brush</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vect_sharp_1_1_brush.html">Brush</a> VectSharp.FormattedText.Brush</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Represents the brush that should be used to draw the text. If this is null, the default brush is used.  </p>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00071">71</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<a id="ae43fc6b7442e9dd369803f33e6ddbaac" name="ae43fc6b7442e9dd369803f33e6ddbaac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae43fc6b7442e9dd369803f33e6ddbaac">&#9670;&#160;</a></span>Font</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vect_sharp_1_1_font.html">Font</a> VectSharp.FormattedText.Font</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Represents the font that should be used to draw the text.  </p>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00061">61</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<a id="a880e388b62bd8493da1ccd58668784b9" name="a880e388b62bd8493da1ccd58668784b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a880e388b62bd8493da1ccd58668784b9">&#9670;&#160;</a></span>Script</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespace_vect_sharp.html#ad89d060535c63df4196d494335867778">Script</a> VectSharp.FormattedText.Script</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Represents the position of the text.  </p>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00066">66</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<a id="a95f38776549b8a485840fd17c1b341b4" name="a95f38776549b8a485840fd17c1b341b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95f38776549b8a485840fd17c1b341b4">&#9670;&#160;</a></span>Spacing</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_vect_sharp_1_1_text_spacing.html">TextSpacing</a> VectSharp.FormattedText.Spacing</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Represents the text spacing parameters used to draw the text.  </p>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00076">76</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<a id="afd922b76c7912503e48ae104216287cf" name="afd922b76c7912503e48ae104216287cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd922b76c7912503e48ae104216287cf">&#9670;&#160;</a></span>Text</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string VectSharp.FormattedText.Text</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Represents the text represented by this instance.  </p>

<p class="definition">Definition at line <a class="el" href="_formatted_text_8cs_source.html#l00056">56</a> of file <a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>VectSharp/<a class="el" href="_formatted_text_8cs_source.html">FormattedText.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_vect_sharp.html">VectSharp</a></li><li class="navelem"><a class="el" href="class_vect_sharp_1_1_formatted_text.html">FormattedText</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
  </ul>
</div>
</body>
</html>
